/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.core.metamodel.facets.object.publish.entitychange;


import org.apache.causeway.core.metamodel.facetapi.Facet;
import org.apache.causeway.core.metamodel.facetapi.FacetHolder;
import org.apache.causeway.core.metamodel.spec.ObjectSpecification;

import lombok.val;


/**
 * Corresponds to annotating the entity class with
 * {@Code @DomainObject(entityChangePublishing=ENABLED)}.
 *
 * @since 2.0
 */
public interface EntityChangePublishingFacet extends Facet {

    public static boolean isPublishingEnabled(final FacetHolder facetHolder) {
        if(facetHolder==null) {
            return false;
        }

        if(facetHolder instanceof ObjectSpecification) {
            if(!((ObjectSpecification)facetHolder).isEntity()) {
                return false;
            }
        }

        val entityChangePublishingFacet = facetHolder.getFacet(EntityChangePublishingFacet.class);
        return entityChangePublishingFacet != null
                && entityChangePublishingFacet.isEnabled();
    }

    boolean isEnabled();

}
